Skip to content

Add Room Name to output ports#5

Merged
tomdixon merged 1 commit intoclockwork-dog:mainfrom
almost:main
May 2, 2025
Merged

Add Room Name to output ports#5
tomdixon merged 1 commit intoclockwork-dog:mainfrom
almost:main

Conversation

@almost
Copy link
Contributor

@almost almost commented May 2, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features

    • Added "Room Name" as a new data field available to the COGS show from Buzzshot.

  • Documentation

    • Updated the README to include "Room Name" in the list of available data fields.

  • Chores

    • Increased the project version to 0.1.7.

@coderabbitai
Copy link

coderabbitai bot commented May 2, 2025

Walkthrough

The changes introduce "Room Name" as a new data field provided by the plugin. The README documentation is updated to reflect this addition. The plugin's code is modified to include "Room Name" as an output port, ensuring it is populated with the current game's room name or an empty string if unavailable. The package version is incremented from 0.1.6 to 0.1.7 in the package manifest. No other logic, dependencies, or public API elements are altered.

Changes

File(s) Change Summary
README.md Updated documentation to include "Room Name" in the list of available data fields.
package.json Incremented project version from 0.1.6 to 0.1.7.
src/BuzzshotCogsPlugin.ts Added "Room Name" as an output port in the interface and updated logic to provide the room name value.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bfa9bc9 and 5dde755.

📒 Files selected for processing (3)
  • README.md (1 hunks)
  • package.json (1 hunks)
  • src/BuzzshotCogsPlugin.ts (2 hunks)
🔇 Additional comments (4)
package.json (1)

3-3: Version bump to 0.1.7
The version in package.json has been correctly incremented to reflect the new release.

README.md (1)

48-48: Documentation updated with "Room Name" output port
The new data field is added to the synchronized data list and aligns with the plugin’s interface.

src/BuzzshotCogsPlugin.ts (2)

32-34: Add new output port "Room Name" to interface
The CogsConnectionParams.outputPorts interface is correctly extended with "Room Name": string.

176-178: Populate "Room Name" in output values
The updateOutputPortValues method now sets the Room Name port using optional chaining to avoid undefined errors.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@tomdixon tomdixon merged commit 711acd2 into clockwork-dog:main May 2, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tomdixon tomdixon tomdixon approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@almost @tomdixon